From 7d04663398d160fa7930edcbfdb2fd960c16025e Mon Sep 17 00:00:00 2001 From: =?utf8?q?Bartosz=20Dziewo=C5=84ski?= Date: Sat, 23 Aug 2014 14:25:02 +0200 Subject: [PATCH] Split includes/Pager.php Change-Id: I67fcffca4e3de081a895deb1a285a5545940ece9 --- includes/AutoLoader.php | 12 +- includes/pager/AlphabeticPager.php | 108 ++++ includes/{Pager.php => pager/IndexPager.php} | 602 ------------------- includes/pager/Pager.php | 35 ++ includes/pager/ReverseChronologicalPager.php | 118 ++++ includes/pager/TablePager.php | 429 +++++++++++++ 6 files changed, 697 insertions(+), 607 deletions(-) create mode 100644 includes/pager/AlphabeticPager.php rename includes/{Pager.php => pager/IndexPager.php} (58%) create mode 100644 includes/pager/Pager.php create mode 100644 includes/pager/ReverseChronologicalPager.php create mode 100644 includes/pager/TablePager.php diff --git a/includes/AutoLoader.php b/includes/AutoLoader.php index 38e92b6059..2c71ce869e 100644 --- a/includes/AutoLoader.php +++ b/includes/AutoLoader.php @@ -31,7 +31,6 @@ $wgAutoloadLocalClasses = array( # Includes 'AjaxDispatcher' => 'includes/AjaxDispatcher.php', 'AjaxResponse' => 'includes/AjaxResponse.php', - 'AlphabeticPager' => 'includes/Pager.php', 'AtomFeed' => 'includes/Feed.php', 'AuthPlugin' => 'includes/AuthPlugin.php', 'AuthPluginUser' => 'includes/AuthPlugin.php', @@ -110,7 +109,6 @@ $wgAutoloadLocalClasses = array( 'IdentityCollation' => 'includes/Collation.php', 'ImportStreamSource' => 'includes/Import.php', 'ImportStringSource' => 'includes/Import.php', - 'IndexPager' => 'includes/Pager.php', 'Interwiki' => 'includes/interwiki/Interwiki.php', 'License' => 'includes/Licenses.php', 'Licenses' => 'includes/Licenses.php', @@ -128,7 +126,6 @@ $wgAutoloadLocalClasses = array( 'MWHttpRequest' => 'includes/HttpFunctions.php', 'MWNamespace' => 'includes/MWNamespace.php', 'OutputPage' => 'includes/OutputPage.php', - 'Pager' => 'includes/Pager.php', 'PathRouter' => 'includes/PathRouter.php', 'PathRouterPatternReplacer' => 'includes/PathRouter.php', 'PhpHttpRequest' => 'includes/HttpFunctions.php', @@ -143,7 +140,6 @@ $wgAutoloadLocalClasses = array( 'PrefixSearch' => 'includes/PrefixSearch.php', 'ProtectionForm' => 'includes/ProtectionForm.php', 'RawMessage' => 'includes/Message.php', - 'ReverseChronologicalPager' => 'includes/Pager.php', 'RevisionItem' => 'includes/RevisionList.php', 'RevisionItemBase' => 'includes/RevisionList.php', 'RevisionListBase' => 'includes/RevisionList.php', @@ -162,7 +158,6 @@ $wgAutoloadLocalClasses = array( 'StringPrefixSearch' => 'includes/PrefixSearch.php', 'StubObject' => 'includes/StubObject.php', 'StubUserLang' => 'includes/StubObject.php', - 'TablePager' => 'includes/Pager.php', 'MWTimestamp' => 'includes/MWTimestamp.php', 'TimestampException' => 'includes/TimestampException.php', 'Title' => 'includes/Title.php', @@ -787,6 +782,13 @@ $wgAutoloadLocalClasses = array( 'WikiFilePage' => 'includes/page/WikiFilePage.php', 'WikiPage' => 'includes/page/WikiPage.php', + # includes/pager + 'AlphabeticPager' => 'includes/pager/AlphabeticPager.php', + 'IndexPager' => 'includes/pager/IndexPager.php', + 'Pager' => 'includes/pager/Pager.php', + 'ReverseChronologicalPager' => 'includes/pager/ReverseChronologicalPager.php', + 'TablePager' => 'includes/pager/TablePager.php', + # includes/parser 'CacheTime' => 'includes/parser/CacheTime.php', 'CoreParserFunctions' => 'includes/parser/CoreParserFunctions.php', diff --git a/includes/pager/AlphabeticPager.php b/includes/pager/AlphabeticPager.php new file mode 100644 index 0000000000..34c78976cb --- /dev/null +++ b/includes/pager/AlphabeticPager.php @@ -0,0 +1,108 @@ +isNavigationBarShown() ) { + return ''; + } + + if ( isset( $this->mNavigationBar ) ) { + return $this->mNavigationBar; + } + + $linkTexts = array( + 'prev' => $this->msg( 'prevn' )->numParams( $this->mLimit )->escaped(), + 'next' => $this->msg( 'nextn' )->numParams( $this->mLimit )->escaped(), + 'first' => $this->msg( 'page_first' )->escaped(), + 'last' => $this->msg( 'page_last' )->escaped() + ); + + $lang = $this->getLanguage(); + + $pagingLinks = $this->getPagingLinks( $linkTexts ); + $limitLinks = $this->getLimitLinks(); + $limits = $lang->pipeList( $limitLinks ); + + $this->mNavigationBar = $this->msg( 'parentheses' )->rawParams( + $lang->pipeList( array( $pagingLinks['first'], + $pagingLinks['last'] ) ) )->escaped() . " " . + $this->msg( 'viewprevnext' )->rawParams( $pagingLinks['prev'], + $pagingLinks['next'], $limits )->escaped(); + + if ( !is_array( $this->getIndexField() ) ) { + # Early return to avoid undue nesting + return $this->mNavigationBar; + } + + $extra = ''; + $first = true; + $msgs = $this->getOrderTypeMessages(); + foreach ( array_keys( $msgs ) as $order ) { + if ( $first ) { + $first = false; + } else { + $extra .= $this->msg( 'pipe-separator' )->escaped(); + } + + if ( $order == $this->mOrderType ) { + $extra .= $this->msg( $msgs[$order] )->escaped(); + } else { + $extra .= $this->makeLink( + $this->msg( $msgs[$order] )->escaped(), + array( 'order' => $order ) + ); + } + } + + if ( $extra !== '' ) { + $extra = ' ' . $this->msg( 'parentheses' )->rawParams( $extra )->escaped(); + $this->mNavigationBar .= $extra; + } + + return $this->mNavigationBar; + } + + /** + * If this supports multiple order type messages, give the message key for + * enabling each one in getNavigationBar. The return type is an associative + * array whose keys must exactly match the keys of the array returned + * by getIndexField(), and whose values are message keys. + * + * @return array + */ + protected function getOrderTypeMessages() { + return null; + } +} diff --git a/includes/Pager.php b/includes/pager/IndexPager.php similarity index 58% rename from includes/Pager.php rename to includes/pager/IndexPager.php index c7de8c1ea0..1d93c27f68 100644 --- a/includes/Pager.php +++ b/includes/pager/IndexPager.php @@ -21,19 +21,6 @@ * @ingroup Pager */ -/** - * @defgroup Pager Pager - */ - -/** - * Basic pager interface. - * @ingroup Pager - */ -interface Pager { - function getNavigationBar(); - function getBody(); -} - /** * IndexPager is an efficient pager which uses a (roughly unique) index in the * data set to implement paging, rather than a "LIMIT offset,limit" clause. @@ -740,592 +727,3 @@ abstract class IndexPager extends ContextSource implements Pager { return false; } } - -/** - * IndexPager with an alphabetic list and a formatted navigation bar - * @ingroup Pager - */ -abstract class AlphabeticPager extends IndexPager { - - /** - * Shamelessly stolen bits from ReverseChronologicalPager, - * didn't want to do class magic as may be still revamped - * - * @return string HTML - */ - function getNavigationBar() { - if ( !$this->isNavigationBarShown() ) { - return ''; - } - - if ( isset( $this->mNavigationBar ) ) { - return $this->mNavigationBar; - } - - $linkTexts = array( - 'prev' => $this->msg( 'prevn' )->numParams( $this->mLimit )->escaped(), - 'next' => $this->msg( 'nextn' )->numParams( $this->mLimit )->escaped(), - 'first' => $this->msg( 'page_first' )->escaped(), - 'last' => $this->msg( 'page_last' )->escaped() - ); - - $lang = $this->getLanguage(); - - $pagingLinks = $this->getPagingLinks( $linkTexts ); - $limitLinks = $this->getLimitLinks(); - $limits = $lang->pipeList( $limitLinks ); - - $this->mNavigationBar = $this->msg( 'parentheses' )->rawParams( - $lang->pipeList( array( $pagingLinks['first'], - $pagingLinks['last'] ) ) )->escaped() . " " . - $this->msg( 'viewprevnext' )->rawParams( $pagingLinks['prev'], - $pagingLinks['next'], $limits )->escaped(); - - if ( !is_array( $this->getIndexField() ) ) { - # Early return to avoid undue nesting - return $this->mNavigationBar; - } - - $extra = ''; - $first = true; - $msgs = $this->getOrderTypeMessages(); - foreach ( array_keys( $msgs ) as $order ) { - if ( $first ) { - $first = false; - } else { - $extra .= $this->msg( 'pipe-separator' )->escaped(); - } - - if ( $order == $this->mOrderType ) { - $extra .= $this->msg( $msgs[$order] )->escaped(); - } else { - $extra .= $this->makeLink( - $this->msg( $msgs[$order] )->escaped(), - array( 'order' => $order ) - ); - } - } - - if ( $extra !== '' ) { - $extra = ' ' . $this->msg( 'parentheses' )->rawParams( $extra )->escaped(); - $this->mNavigationBar .= $extra; - } - - return $this->mNavigationBar; - } - - /** - * If this supports multiple order type messages, give the message key for - * enabling each one in getNavigationBar. The return type is an associative - * array whose keys must exactly match the keys of the array returned - * by getIndexField(), and whose values are message keys. - * - * @return array - */ - protected function getOrderTypeMessages() { - return null; - } -} - -/** - * IndexPager with a formatted navigation bar - * @ingroup Pager - */ -abstract class ReverseChronologicalPager extends IndexPager { - public $mDefaultDirection = true; - public $mYear; - public $mMonth; - - function getNavigationBar() { - if ( !$this->isNavigationBarShown() ) { - return ''; - } - - if ( isset( $this->mNavigationBar ) ) { - return $this->mNavigationBar; - } - - $linkTexts = array( - 'prev' => $this->msg( 'pager-newer-n' )->numParams( $this->mLimit )->escaped(), - 'next' => $this->msg( 'pager-older-n' )->numParams( $this->mLimit )->escaped(), - 'first' => $this->msg( 'histlast' )->escaped(), - 'last' => $this->msg( 'histfirst' )->escaped() - ); - - $pagingLinks = $this->getPagingLinks( $linkTexts ); - $limitLinks = $this->getLimitLinks(); - $limits = $this->getLanguage()->pipeList( $limitLinks ); - $firstLastLinks = $this->msg( 'parentheses' )->rawParams( "{$pagingLinks['first']}" . - $this->msg( 'pipe-separator' )->escaped() . - "{$pagingLinks['last']}" )->escaped(); - - $this->mNavigationBar = $firstLastLinks . ' ' . - $this->msg( 'viewprevnext' )->rawParams( - $pagingLinks['prev'], $pagingLinks['next'], $limits )->escaped(); - - return $this->mNavigationBar; - } - - function getDateCond( $year, $month ) { - $year = intval( $year ); - $month = intval( $month ); - - // Basic validity checks - $this->mYear = $year > 0 ? $year : false; - $this->mMonth = ( $month > 0 && $month < 13 ) ? $month : false; - - // Given an optional year and month, we need to generate a timestamp - // to use as "WHERE rev_timestamp <= result" - // Examples: year = 2006 equals < 20070101 (+000000) - // year=2005, month=1 equals < 20050201 - // year=2005, month=12 equals < 20060101 - if ( !$this->mYear && !$this->mMonth ) { - return; - } - - if ( $this->mYear ) { - $year = $this->mYear; - } else { - // If no year given, assume the current one - $timestamp = MWTimestamp::getInstance(); - $year = $timestamp->format( 'Y' ); - // If this month hasn't happened yet this year, go back to last year's month - if ( $this->mMonth > $timestamp->format( 'n' ) ) { - $year--; - } - } - - if ( $this->mMonth ) { - $month = $this->mMonth + 1; - // For December, we want January 1 of the next year - if ( $month > 12 ) { - $month = 1; - $year++; - } - } else { - // No month implies we want up to the end of the year in question - $month = 1; - $year++; - } - - // Y2K38 bug - if ( $year > 2032 ) { - $year = 2032; - } - - $ymd = (int)sprintf( "%04d%02d01", $year, $month ); - - if ( $ymd > 20320101 ) { - $ymd = 20320101; - } - - $this->mOffset = $this->mDb->timestamp( "${ymd}000000" ); - } -} - -/** - * Table-based display with a user-selectable sort order - * @ingroup Pager - */ -abstract class TablePager extends IndexPager { - protected $mSort; - - protected $mCurrentRow; - - public function __construct( IContextSource $context = null ) { - if ( $context ) { - $this->setContext( $context ); - } - - $this->mSort = $this->getRequest()->getText( 'sort' ); - if ( !array_key_exists( $this->mSort, $this->getFieldNames() ) - || !$this->isFieldSortable( $this->mSort ) - ) { - $this->mSort = $this->getDefaultSort(); - } - if ( $this->getRequest()->getBool( 'asc' ) ) { - $this->mDefaultDirection = false; - } elseif ( $this->getRequest()->getBool( 'desc' ) ) { - $this->mDefaultDirection = true; - } /* Else leave it at whatever the class default is */ - - parent::__construct(); - } - - /** - * @protected - * @return string - */ - function getStartBody() { - global $wgStylePath; - $sortClass = $this->getSortHeaderClass(); - - $s = ''; - $fields = $this->getFieldNames(); - - # Make table header - foreach ( $fields as $field => $name ) { - if ( strval( $name ) == '' ) { - $s .= Html::rawElement( 'th', array(), ' ' ) . "\n"; - } elseif ( $this->isFieldSortable( $field ) ) { - $query = array( 'sort' => $field, 'limit' => $this->mLimit ); - if ( $field == $this->mSort ) { - # This is the sorted column - # Prepare a link that goes in the other sort order - if ( $this->mDefaultDirection ) { - # Descending - $image = 'Arr_d.png'; - $query['asc'] = '1'; - $query['desc'] = ''; - $alt = $this->msg( 'descending_abbrev' )->escaped(); - } else { - # Ascending - $image = 'Arr_u.png'; - $query['asc'] = ''; - $query['desc'] = '1'; - $alt = $this->msg( 'ascending_abbrev' )->escaped(); - } - $image = "$wgStylePath/common/images/$image"; - $link = $this->makeLink( - Html::element( 'img', array( 'width' => 12, 'height' => 12, - 'alt' => $alt, 'src' => $image ) ) . htmlspecialchars( $name ), $query ); - $s .= Html::rawElement( 'th', array( 'class' => $sortClass ), $link ) . "\n"; - } else { - $s .= Html::rawElement( 'th', array(), - $this->makeLink( htmlspecialchars( $name ), $query ) ) . "\n"; - } - } else { - $s .= Html::element( 'th', array(), $name ) . "\n"; - } - } - - $tableClass = $this->getTableClass(); - $ret = Html::openElement( 'table', array( - 'style' => 'border:1px;', - 'class' => "mw-datatable $tableClass" ) - ); - $ret .= Html::rawElement( 'thead', array(), Html::rawElement( 'tr', array(), "\n" . $s . "\n" ) ); - $ret .= Html::openElement( 'tbody' ) . "\n"; - - return $ret; - } - - /** - * @protected - * @return string - */ - function getEndBody() { - return "\n"; - } - - /** - * @protected - * @return string - */ - function getEmptyBody() { - $colspan = count( $this->getFieldNames() ); - $msgEmpty = $this->msg( 'table_pager_empty' )->text(); - return Html::rawElement( 'tr', array(), - Html::element( 'td', array( 'colspan' => $colspan ), $msgEmpty ) ); - } - - /** - * @protected - * @param stdClass $row - * @return string HTML - */ - function formatRow( $row ) { - $this->mCurrentRow = $row; // In case formatValue etc need to know - $s = Html::openElement( 'tr', $this->getRowAttrs( $row ) ) . "\n"; - $fieldNames = $this->getFieldNames(); - - foreach ( $fieldNames as $field => $name ) { - $value = isset( $row->$field ) ? $row->$field : null; - $formatted = strval( $this->formatValue( $field, $value ) ); - - if ( $formatted == '' ) { - $formatted = ' '; - } - - $s .= Html::rawElement( 'td', $this->getCellAttrs( $field, $value ), $formatted ) . "\n"; - } - - $s .= Html::closeElement( 'tr' ) . "\n"; - - return $s; - } - - /** - * Get a class name to be applied to the given row. - * - * @protected - * - * @param object $row The database result row - * @return string - */ - function getRowClass( $row ) { - return ''; - } - - /** - * Get attributes to be applied to the given row. - * - * @protected - * - * @param object $row The database result row - * @return array Array of attribute => value - */ - function getRowAttrs( $row ) { - $class = $this->getRowClass( $row ); - if ( $class === '' ) { - // Return an empty array to avoid clutter in HTML like class="" - return array(); - } else { - return array( 'class' => $this->getRowClass( $row ) ); - } - } - - /** - * Get any extra attributes to be applied to the given cell. Don't - * take this as an excuse to hardcode styles; use classes and - * CSS instead. Row context is available in $this->mCurrentRow - * - * @protected - * - * @param string $field The column - * @param string $value The cell contents - * @return array Array of attr => value - */ - function getCellAttrs( $field, $value ) { - return array( 'class' => 'TablePager_col_' . $field ); - } - - /** - * @protected - * @return string - */ - function getIndexField() { - return $this->mSort; - } - - /** - * @protected - * @return string - */ - function getTableClass() { - return 'TablePager'; - } - - /** - * @protected - * @return string - */ - function getNavClass() { - return 'TablePager_nav'; - } - - /** - * @protected - * @return string - */ - function getSortHeaderClass() { - return 'TablePager_sort'; - } - - /** - * A navigation bar with images - * @return string HTML - */ - public function getNavigationBar() { - global $wgStylePath; - - if ( !$this->isNavigationBarShown() ) { - return ''; - } - - $path = "$wgStylePath/common/images"; - $labels = array( - 'first' => 'table_pager_first', - 'prev' => 'table_pager_prev', - 'next' => 'table_pager_next', - 'last' => 'table_pager_last', - ); - $images = array( - 'first' => 'arrow_first_25.png', - 'prev' => 'arrow_left_25.png', - 'next' => 'arrow_right_25.png', - 'last' => 'arrow_last_25.png', - ); - $disabledImages = array( - 'first' => 'arrow_disabled_first_25.png', - 'prev' => 'arrow_disabled_left_25.png', - 'next' => 'arrow_disabled_right_25.png', - 'last' => 'arrow_disabled_last_25.png', - ); - if ( $this->getLanguage()->isRTL() ) { - $keys = array_keys( $labels ); - $images = array_combine( $keys, array_reverse( $images ) ); - $disabledImages = array_combine( $keys, array_reverse( $disabledImages ) ); - } - - $linkTexts = array(); - $disabledTexts = array(); - foreach ( $labels as $type => $label ) { - $msgLabel = $this->msg( $label )->escaped(); - $linkTexts[$type] = Html::element( 'img', array( 'src' => "$path/{$images[$type]}", - 'alt' => $msgLabel ) ) . "
$msgLabel"; - $disabledTexts[$type] = Html::element( 'img', array( 'src' => "$path/{$disabledImages[$type]}", - 'alt' => $msgLabel ) ) . "
$msgLabel"; - } - $links = $this->getPagingLinks( $linkTexts, $disabledTexts ); - - $s = Html::openElement( 'table', array( 'class' => $this->getNavClass() ) ); - $s .= Html::openElement( 'tr' ) . "\n"; - $width = 100 / count( $links ) . '%'; - foreach ( $labels as $type => $label ) { - $s .= Html::rawElement( 'td', array( 'style' => "width:$width;" ), $links[$type] ) . "\n"; - } - $s .= Html::closeElement( 'tr' ) . Html::closeElement( 'table' ) . "\n"; - return $s; - } - - /** - * Get a "" element of limits. - * This can be passed directly to XmlSelect::addOptions(). - * - * @since 1.22 - * @return array - */ - public function getLimitSelectList() { - # Add the current limit from the query string - # to avoid that the limit is lost after clicking Go next time - if ( !in_array( $this->mLimit, $this->mLimitsShown ) ) { - $this->mLimitsShown[] = $this->mLimit; - sort( $this->mLimitsShown ); - } - $ret = array(); - foreach ( $this->mLimitsShown as $key => $value ) { - # The pair is either $index => $limit, in which case the $value - # will be numeric, or $limit => $text, in which case the $value - # will be a string. - if ( is_int( $value ) ) { - $limit = $value; - $text = $this->getLanguage()->formatNum( $limit ); - } else { - $limit = $key; - $text = $value; - } - $ret[$text] = $limit; - } - return $ret; - } - - /** - * Get \ elements for use in a method="get" form. - * Resubmits all defined elements of the query string, except for a - * blacklist, passed in the $blacklist parameter. - * - * @param array $blacklist Parameters from the request query which should not be resubmitted - * @return string HTML fragment - */ - function getHiddenFields( $blacklist = array() ) { - $blacklist = (array)$blacklist; - $query = $this->getRequest()->getQueryValues(); - foreach ( $blacklist as $name ) { - unset( $query[$name] ); - } - $s = ''; - foreach ( $query as $name => $value ) { - $s .= Html::hidden( $name, $value ) . "\n"; - } - return $s; - } - - /** - * Get a form containing a limit selection dropdown - * - * @return string HTML fragment - */ - function getLimitForm() { - global $wgScript; - - return Html::rawElement( - 'form', - array( - 'method' => 'get', - 'action' => $wgScript - ), - "\n" . $this->getLimitDropdown() - ) . "\n"; - } - - /** - * Gets a limit selection dropdown - * - * @return string - */ - function getLimitDropdown() { - # Make the select with some explanatory text - $msgSubmit = $this->msg( 'table_pager_limit_submit' )->escaped(); - - return $this->msg( 'table_pager_limit' ) - ->rawParams( $this->getLimitSelect() )->escaped() . - "\n\n" . - $this->getHiddenFields( array( 'limit' ) ); - } - - /** - * Return true if the named field should be sortable by the UI, false - * otherwise - * - * @param string $field - */ - abstract function isFieldSortable( $field ); - - /** - * Format a table cell. The return value should be HTML, but use an empty - * string not   for empty cells. Do not include the and . - * - * The current result row is available as $this->mCurrentRow, in case you - * need more context. - * - * @protected - * - * @param string $name The database field name - * @param string $value The value retrieved from the database - */ - abstract function formatValue( $name, $value ); - - /** - * The database field name used as a default sort order. - * - * @protected - * - * @return string - */ - abstract function getDefaultSort(); - - /** - * An array mapping database field names to a textual description of the - * field name, for use in the table header. The description should be plain - * text, it will be HTML-escaped later. - * - * @return array - */ - abstract function getFieldNames(); -} diff --git a/includes/pager/Pager.php b/includes/pager/Pager.php new file mode 100644 index 0000000000..edec490c73 --- /dev/null +++ b/includes/pager/Pager.php @@ -0,0 +1,35 @@ +isNavigationBarShown() ) { + return ''; + } + + if ( isset( $this->mNavigationBar ) ) { + return $this->mNavigationBar; + } + + $linkTexts = array( + 'prev' => $this->msg( 'pager-newer-n' )->numParams( $this->mLimit )->escaped(), + 'next' => $this->msg( 'pager-older-n' )->numParams( $this->mLimit )->escaped(), + 'first' => $this->msg( 'histlast' )->escaped(), + 'last' => $this->msg( 'histfirst' )->escaped() + ); + + $pagingLinks = $this->getPagingLinks( $linkTexts ); + $limitLinks = $this->getLimitLinks(); + $limits = $this->getLanguage()->pipeList( $limitLinks ); + $firstLastLinks = $this->msg( 'parentheses' )->rawParams( "{$pagingLinks['first']}" . + $this->msg( 'pipe-separator' )->escaped() . + "{$pagingLinks['last']}" )->escaped(); + + $this->mNavigationBar = $firstLastLinks . ' ' . + $this->msg( 'viewprevnext' )->rawParams( + $pagingLinks['prev'], $pagingLinks['next'], $limits )->escaped(); + + return $this->mNavigationBar; + } + + function getDateCond( $year, $month ) { + $year = intval( $year ); + $month = intval( $month ); + + // Basic validity checks + $this->mYear = $year > 0 ? $year : false; + $this->mMonth = ( $month > 0 && $month < 13 ) ? $month : false; + + // Given an optional year and month, we need to generate a timestamp + // to use as "WHERE rev_timestamp <= result" + // Examples: year = 2006 equals < 20070101 (+000000) + // year=2005, month=1 equals < 20050201 + // year=2005, month=12 equals < 20060101 + if ( !$this->mYear && !$this->mMonth ) { + return; + } + + if ( $this->mYear ) { + $year = $this->mYear; + } else { + // If no year given, assume the current one + $timestamp = MWTimestamp::getInstance(); + $year = $timestamp->format( 'Y' ); + // If this month hasn't happened yet this year, go back to last year's month + if ( $this->mMonth > $timestamp->format( 'n' ) ) { + $year--; + } + } + + if ( $this->mMonth ) { + $month = $this->mMonth + 1; + // For December, we want January 1 of the next year + if ( $month > 12 ) { + $month = 1; + $year++; + } + } else { + // No month implies we want up to the end of the year in question + $month = 1; + $year++; + } + + // Y2K38 bug + if ( $year > 2032 ) { + $year = 2032; + } + + $ymd = (int)sprintf( "%04d%02d01", $year, $month ); + + if ( $ymd > 20320101 ) { + $ymd = 20320101; + } + + $this->mOffset = $this->mDb->timestamp( "${ymd}000000" ); + } +} diff --git a/includes/pager/TablePager.php b/includes/pager/TablePager.php new file mode 100644 index 0000000000..19538c6ac8 --- /dev/null +++ b/includes/pager/TablePager.php @@ -0,0 +1,429 @@ +setContext( $context ); + } + + $this->mSort = $this->getRequest()->getText( 'sort' ); + if ( !array_key_exists( $this->mSort, $this->getFieldNames() ) + || !$this->isFieldSortable( $this->mSort ) + ) { + $this->mSort = $this->getDefaultSort(); + } + if ( $this->getRequest()->getBool( 'asc' ) ) { + $this->mDefaultDirection = false; + } elseif ( $this->getRequest()->getBool( 'desc' ) ) { + $this->mDefaultDirection = true; + } /* Else leave it at whatever the class default is */ + + parent::__construct(); + } + + /** + * @protected + * @return string + */ + function getStartBody() { + global $wgStylePath; + $sortClass = $this->getSortHeaderClass(); + + $s = ''; + $fields = $this->getFieldNames(); + + # Make table header + foreach ( $fields as $field => $name ) { + if ( strval( $name ) == '' ) { + $s .= Html::rawElement( 'th', array(), ' ' ) . "\n"; + } elseif ( $this->isFieldSortable( $field ) ) { + $query = array( 'sort' => $field, 'limit' => $this->mLimit ); + if ( $field == $this->mSort ) { + # This is the sorted column + # Prepare a link that goes in the other sort order + if ( $this->mDefaultDirection ) { + # Descending + $image = 'Arr_d.png'; + $query['asc'] = '1'; + $query['desc'] = ''; + $alt = $this->msg( 'descending_abbrev' )->escaped(); + } else { + # Ascending + $image = 'Arr_u.png'; + $query['asc'] = ''; + $query['desc'] = '1'; + $alt = $this->msg( 'ascending_abbrev' )->escaped(); + } + $image = "$wgStylePath/common/images/$image"; + $link = $this->makeLink( + Html::element( 'img', array( 'width' => 12, 'height' => 12, + 'alt' => $alt, 'src' => $image ) ) . htmlspecialchars( $name ), $query ); + $s .= Html::rawElement( 'th', array( 'class' => $sortClass ), $link ) . "\n"; + } else { + $s .= Html::rawElement( 'th', array(), + $this->makeLink( htmlspecialchars( $name ), $query ) ) . "\n"; + } + } else { + $s .= Html::element( 'th', array(), $name ) . "\n"; + } + } + + $tableClass = $this->getTableClass(); + $ret = Html::openElement( 'table', array( + 'style' => 'border:1px;', + 'class' => "mw-datatable $tableClass" ) + ); + $ret .= Html::rawElement( 'thead', array(), Html::rawElement( 'tr', array(), "\n" . $s . "\n" ) ); + $ret .= Html::openElement( 'tbody' ) . "\n"; + + return $ret; + } + + /** + * @protected + * @return string + */ + function getEndBody() { + return "\n"; + } + + /** + * @protected + * @return string + */ + function getEmptyBody() { + $colspan = count( $this->getFieldNames() ); + $msgEmpty = $this->msg( 'table_pager_empty' )->text(); + return Html::rawElement( 'tr', array(), + Html::element( 'td', array( 'colspan' => $colspan ), $msgEmpty ) ); + } + + /** + * @protected + * @param stdClass $row + * @return string HTML + */ + function formatRow( $row ) { + $this->mCurrentRow = $row; // In case formatValue etc need to know + $s = Html::openElement( 'tr', $this->getRowAttrs( $row ) ) . "\n"; + $fieldNames = $this->getFieldNames(); + + foreach ( $fieldNames as $field => $name ) { + $value = isset( $row->$field ) ? $row->$field : null; + $formatted = strval( $this->formatValue( $field, $value ) ); + + if ( $formatted == '' ) { + $formatted = ' '; + } + + $s .= Html::rawElement( 'td', $this->getCellAttrs( $field, $value ), $formatted ) . "\n"; + } + + $s .= Html::closeElement( 'tr' ) . "\n"; + + return $s; + } + + /** + * Get a class name to be applied to the given row. + * + * @protected + * + * @param object $row The database result row + * @return string + */ + function getRowClass( $row ) { + return ''; + } + + /** + * Get attributes to be applied to the given row. + * + * @protected + * + * @param object $row The database result row + * @return array Array of attribute => value + */ + function getRowAttrs( $row ) { + $class = $this->getRowClass( $row ); + if ( $class === '' ) { + // Return an empty array to avoid clutter in HTML like class="" + return array(); + } else { + return array( 'class' => $this->getRowClass( $row ) ); + } + } + + /** + * Get any extra attributes to be applied to the given cell. Don't + * take this as an excuse to hardcode styles; use classes and + * CSS instead. Row context is available in $this->mCurrentRow + * + * @protected + * + * @param string $field The column + * @param string $value The cell contents + * @return array Array of attr => value + */ + function getCellAttrs( $field, $value ) { + return array( 'class' => 'TablePager_col_' . $field ); + } + + /** + * @protected + * @return string + */ + function getIndexField() { + return $this->mSort; + } + + /** + * @protected + * @return string + */ + function getTableClass() { + return 'TablePager'; + } + + /** + * @protected + * @return string + */ + function getNavClass() { + return 'TablePager_nav'; + } + + /** + * @protected + * @return string + */ + function getSortHeaderClass() { + return 'TablePager_sort'; + } + + /** + * A navigation bar with images + * @return string HTML + */ + public function getNavigationBar() { + global $wgStylePath; + + if ( !$this->isNavigationBarShown() ) { + return ''; + } + + $path = "$wgStylePath/common/images"; + $labels = array( + 'first' => 'table_pager_first', + 'prev' => 'table_pager_prev', + 'next' => 'table_pager_next', + 'last' => 'table_pager_last', + ); + $images = array( + 'first' => 'arrow_first_25.png', + 'prev' => 'arrow_left_25.png', + 'next' => 'arrow_right_25.png', + 'last' => 'arrow_last_25.png', + ); + $disabledImages = array( + 'first' => 'arrow_disabled_first_25.png', + 'prev' => 'arrow_disabled_left_25.png', + 'next' => 'arrow_disabled_right_25.png', + 'last' => 'arrow_disabled_last_25.png', + ); + if ( $this->getLanguage()->isRTL() ) { + $keys = array_keys( $labels ); + $images = array_combine( $keys, array_reverse( $images ) ); + $disabledImages = array_combine( $keys, array_reverse( $disabledImages ) ); + } + + $linkTexts = array(); + $disabledTexts = array(); + foreach ( $labels as $type => $label ) { + $msgLabel = $this->msg( $label )->escaped(); + $linkTexts[$type] = Html::element( 'img', array( 'src' => "$path/{$images[$type]}", + 'alt' => $msgLabel ) ) . "
$msgLabel"; + $disabledTexts[$type] = Html::element( 'img', array( 'src' => "$path/{$disabledImages[$type]}", + 'alt' => $msgLabel ) ) . "
$msgLabel"; + } + $links = $this->getPagingLinks( $linkTexts, $disabledTexts ); + + $s = Html::openElement( 'table', array( 'class' => $this->getNavClass() ) ); + $s .= Html::openElement( 'tr' ) . "\n"; + $width = 100 / count( $links ) . '%'; + foreach ( $labels as $type => $label ) { + $s .= Html::rawElement( 'td', array( 'style' => "width:$width;" ), $links[$type] ) . "\n"; + } + $s .= Html::closeElement( 'tr' ) . Html::closeElement( 'table' ) . "\n"; + return $s; + } + + /** + * Get a "" element of limits. + * This can be passed directly to XmlSelect::addOptions(). + * + * @since 1.22 + * @return array + */ + public function getLimitSelectList() { + # Add the current limit from the query string + # to avoid that the limit is lost after clicking Go next time + if ( !in_array( $this->mLimit, $this->mLimitsShown ) ) { + $this->mLimitsShown[] = $this->mLimit; + sort( $this->mLimitsShown ); + } + $ret = array(); + foreach ( $this->mLimitsShown as $key => $value ) { + # The pair is either $index => $limit, in which case the $value + # will be numeric, or $limit => $text, in which case the $value + # will be a string. + if ( is_int( $value ) ) { + $limit = $value; + $text = $this->getLanguage()->formatNum( $limit ); + } else { + $limit = $key; + $text = $value; + } + $ret[$text] = $limit; + } + return $ret; + } + + /** + * Get \ elements for use in a method="get" form. + * Resubmits all defined elements of the query string, except for a + * blacklist, passed in the $blacklist parameter. + * + * @param array $blacklist Parameters from the request query which should not be resubmitted + * @return string HTML fragment + */ + function getHiddenFields( $blacklist = array() ) { + $blacklist = (array)$blacklist; + $query = $this->getRequest()->getQueryValues(); + foreach ( $blacklist as $name ) { + unset( $query[$name] ); + } + $s = ''; + foreach ( $query as $name => $value ) { + $s .= Html::hidden( $name, $value ) . "\n"; + } + return $s; + } + + /** + * Get a form containing a limit selection dropdown + * + * @return string HTML fragment + */ + function getLimitForm() { + global $wgScript; + + return Html::rawElement( + 'form', + array( + 'method' => 'get', + 'action' => $wgScript + ), + "\n" . $this->getLimitDropdown() + ) . "\n"; + } + + /** + * Gets a limit selection dropdown + * + * @return string + */ + function getLimitDropdown() { + # Make the select with some explanatory text + $msgSubmit = $this->msg( 'table_pager_limit_submit' )->escaped(); + + return $this->msg( 'table_pager_limit' ) + ->rawParams( $this->getLimitSelect() )->escaped() . + "\n\n" . + $this->getHiddenFields( array( 'limit' ) ); + } + + /** + * Return true if the named field should be sortable by the UI, false + * otherwise + * + * @param string $field + */ + abstract function isFieldSortable( $field ); + + /** + * Format a table cell. The return value should be HTML, but use an empty + * string not   for empty cells. Do not include the and . + * + * The current result row is available as $this->mCurrentRow, in case you + * need more context. + * + * @protected + * + * @param string $name The database field name + * @param string $value The value retrieved from the database + */ + abstract function formatValue( $name, $value ); + + /** + * The database field name used as a default sort order. + * + * @protected + * + * @return string + */ + abstract function getDefaultSort(); + + /** + * An array mapping database field names to a textual description of the + * field name, for use in the table header. The description should be plain + * text, it will be HTML-escaped later. + * + * @return array + */ + abstract function getFieldNames(); +} -- 2.20.1